/*
 * Copyright 2013 floreysoft GmbH (www.floreysoft.net)
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.floreysoft.gwt.drive.client.realtime;

import com.google.gwt.core.client.JavaScriptObject;


/**
 * An event that indicates that the save state of a document has changed. If
 * both isSaving and isPending are false, the document is completely saved and
 * up to date.
 */
public final class DocumentSaveStateChangedEvent extends JavaScriptObject {

	protected DocumentSaveStateChangedEvent() {
	}

	/**
	 * @return If true, the client has mutations that have not yet been sent to
	 *         the server. If false, all mutations have been sent to the server,
	 *         but some may not yet have been acked.
	 */
	public native boolean isPending() /*-{
		return !!this.isPending;
	}-*/;

	/**
	 * @return If true, the document is in the process of saving. Mutations have
	 *         been sent to the server, but we have not yet received an ack. If
	 *         false, nothing is in the process of being sent.
	 */
	public native boolean isSaving() /*-{
		return !!this.isSaving;
	}-*/;

}
